Embabel Agent Documentation/com.embabel.agent.rag

Package-level declarations

Types

Traditional RAG. Text chunk

data class DefaultRagResponse(val service: String, val results: List<<Error class: unknown class><out Retrievable>>, val timestamp: Instant) : RagResponse

DepthExplorationRequest

data class DepthExplorationRequest(val depth: Int) : ExplorationRequest

Embedded

interface Embedded

Embedded object instance.

EntityCluster

data class EntityCluster<E>(val anchor: E, val similar: List<<Error class: unknown class><E>>)

Cluster of similar entities

EntityData

interface EntityData : RetrievableEntity

Generic retrieved entity

ExplorationRequest

sealed interface ExplorationRequest

Fact

data class Fact(val assertion: String, val authority: String, val metadata: Map<String, Any?> = emptyMap(), val id: String = UUID.randomUUID().toString()) : Source

A fact.

Ingester

interface Ingester

IngestionResult

data class IngestionResult(val storesWrittenTo: Set<String>, val chunkIds: List<String>)

MappedEntity

interface MappedEntity : RetrievableEntity

Entity mapped with JPA, Neo OGM or another persistence tool. Will be a JVM object. What it exposes beyond RetrievableEntity methods is a matter for the RagService in the application. MappedEntity objects have their own distinct types and can expose

NamedEntityData

interface NamedEntityData : EntityData

Adds a name to the well known entity data.

NavigableRagService

interface NavigableRagService : RagService

Rag service that supports navigation in a graph of retrievable objects. This may not be supported by all RAG services. It need not be a graph but could be implemented by a relational database or other structure.

PathsExplorationRequest

data class PathsExplorationRequest(val paths: List<String>) : ExplorationRequest

RagRequest

data class RagRequest(val query: String, val similarityThreshold: <Error class: unknown class> = 0.8, val topK: Int = 8, val labels: Set<String> = emptySet())

RAG request. Contains a query and parameters for similarity search.

RagResponse

interface RagResponse

Response to a RAG request. Embabel RagResponses can contain results from multiple RAG services. Results are not necessarily chunks, but can be entities.

RagResponseFormatter

fun interface RagResponseFormatter

Implemented by classes that can format RagResponse objects into a string for inclusion in tool responses or prompts.

RagService

interface RagService

Central interface for Retrieval-Augmented Generation (RAG) services. Returns entities as well as text chunks.

RepositoryRagService

interface RepositoryRagService : RagService

RagService comparable to a Spring Data repository.

Retrievable

interface Retrievable

A Retrievable object instance is a chunk or an entity It has a stable id.